<?php
////////////////////////////////////////////////////////////////////////////
//                                                                        //
// NOTICE OF COPYRIGHT                                                    //
//                                                                        //
// Dean`s Office for Moodle                                               //
// Электронный деканат                                                    //
// <http://deansoffice.ru/>                                               //
//                                                                        //
// Copyright (C) 2008-2999  Alex Djachenko (Алексей Дьяченко)             //
// alex-pub@my-site.ru                                                    //
// Copyright (C) 2008-2999  Evgenij Cigancov (Евгений Цыганцов)           //
//                                                                        //
// This program is free software: you can redistribute it and/or modify   //
// it under the terms of the GNU General Public License as published by   //
// the Free Software Foundation, either version 3 of the Licensen.        //
//                                                                        //
// This program is distributed in the hope that it will be useful,        //
// but WITHOUT ANY WARRANTY; without even the implied warranty of         //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          //
// GNU General Public License for more details.                           //
//                                                                        //
// You should have received a copy of the GNU General Public License      //
// along with this program.  If not, see <http://www.gnu.org/licenses/>.  //
//                                                                        //
////////////////////////////////////////////////////////////////////////////


/** Пример плагина интерфейса
 * 
 */
class dof_im_ccleaner implements dof_plugin_im
{
    /**
     * @var dof_control
     */
    protected $dof;
    // **********************************************
    // Методы, предусмотренные интерфейсом plugin
    // **********************************************
    /** 
     * Метод, реализующий инсталяцию плагина в систему
     * Создает или модифицирует существующие таблицы в БД
     * и заполняет их начальными значениями
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function install()
    {
        return true;
    }
    /** 
     * Метод, реализующий обновление плагина в системе
     * Создает или модифицирует существующие таблицы в БД
     * @param string $old_version - версия установленного в системе плагина
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания/изменения?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function upgrade($oldversion)
    {
        return true;
    }
    /** 
     * Возвращает версию установленного плагина
     * @return string
     * @access public
     */
    public function version()
    {
        return 2013022101;
    }
    /** 
     * Возвращает версии интерфейса Деканата, 
     * с которыми этот плагин может работать
     * @return string
     * @access public
     */
    public function compat_dof()
    {
        return 'aquarium';
    }

    /** 
     * Возвращает версии стандарта плагина этого типа, 
     * которым этот плагин соответствует
     * @return string
     * @access public
     */
    public function compat()
    {
        return 'angelfish';
    }
    
    /** 
     * Возвращает тип плагина
     * @return string 
     * @access public
     */
    public function type()
    {
        return 'im';
    }
    /** 
     * Возвращает короткое имя плагина
     * Оно должно быть уникально среди плагинов этого типа
     * @return string
     * @access public
     */
    public function code()
    {
        return 'ccleaner';
    }
    /** 
     * Возвращает список плагинов, 
     * без которых этот плагин работать не может
     * @return array
     * @access public
     */
    public function need_plugins()
    {
        return array('modlib'=>array('nvg'=>2008060300),
                     'modlib'=>array('widgets'=>2008060300),
					 'storage'=>array('persons'=>2008060300,'orders'=>2009050800)/*,
        			 'workflow'=>array('examplewf'=>2008060300),
        			 'sync'=>array('examplesync'=>2008060300),
        			 'im'=>array('admin'=>2008060300)*/);
    }
    /** 
     * Список обрабатываемых плагином событий 
     * @return array - array(array('plugintype'=>..,'plugincode'=>..,'eventcode'=>..),...)
     * @access public
     */
    public function list_catch_events()
    {
       return array(/*array('plugintype'=>'storage', 'plugincode'=>'examplest', 'eventcode'=>'event1'),*/
       				array('plugintype'=>'modlib', 'plugincode'=>'nvg', 'eventcode'=>'event2'));       
    }
    /** 
     * Требуется ли запуск cron в плагине
     * @return bool
     * @access public
     */
    public function is_cron()
    {
		// Этому плагину не нужен крон
		return false;
    }
    
    /** 
     * Проверяет полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта, 
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function is_access($do, $objid = NULL, $userid = NULL)
    {
        // Используем функционал из $DOFFICE
        return $this->dof->is_access($do, NULL, $userid);
    }
    /** 
     * Требует наличия полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта, 
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function require_access($do, $objid = NULL, $userid = NULL)
    {
        // Используем функционал из $DOFFICE
        return $this->dof->require_access($do, NULL, $userid);
    }
    /** 
     * Обработать событие
     * @param string $gentype - тип модуля, сгенерировавшего событие
     * @param string $gencode - код модуля, сгенерировавшего событие
     * @param string $eventcode - код задания
     * @param int $intvar - дополнительный параметр 
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function catch_event($gentype,$gencode,$eventcode,$intvar,$mixedvar)
    {
        return true;
    }
    /** 
     * Запустить обработку периодических процессов
     * @param int $loan - нагрузка (1 - только срочные, 2 - нормальный режим, 3 - ресурсоемкие операции)
     * @param int $messages - количество отображаемых сообщений (0 - не выводить,1 - статистика,
     *  2 - индикатор, 3 - детальная диагностика)
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function cron($loan,$messages)
    {
        /*
        $rez = true;
        // проводим удаление неактивных данных
        $rez = $this->dof->storage('ccleaner')->delete_inactive_data();
        return $rez;
        */
        return true;
    }
    /** 
     * Обработать задание, отложенное ранее в связи с его длительностью
     * @param string $code - код задания
     * @param int $intvar - дополнительный параметр 
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function todo($code,$intvar,$mixedvar)
    {
        return true;
    }
    /** 
     * Конструктор
     * @param dof_control $dof - объект $DOF
     * @access public
     */
    public function __construct($dof)
    {
        $this->dof = $dof;
    }
    // **********************************************
    // Методы, предусмотренные интерфейсом im
    // **********************************************
    /** 
     * Возвращает содержимое блока
     * @param string $name - название набора текстов для отображания
     * @param int $id - id текста в наборе
     * @return string - html-код названия блока
     */
    function get_block($name, $id = 1)
    {
        switch ($name)
		{//выбираем нужнуое содержание по названию
		    case 'main': 
       		 	return '<a href="'.$this->dof->url_im('ccleaner').'">'
							.$this->dof->get_string('title', 'ccleaner').'</a>';
			break;	
			case 'test':
				return $this->dof->get_string('thisis_test_block', 'ccleaner', $id);
			break;
       		default:
       		    {//соответствия не нашлось выведем и имя и id
                    $a = new object;
                    $a->name = $name;
                    $a->id = $id;
				    return $this->dof->get_string('thisis_block_number', 'ccleaner', $a);;
       		    }
		}
    }
    /** Возвращает содержимое секции
     * @param string $name - название набора текстов для отображания
     * @param int $id - id текста в наборе
     * @return string  - html-код названия секции
     */
    function get_section($name, $id = 1)
    {
    	switch ($name)
		{//выбираем содержание
		    case 'test':
                return $this->dof->get_string('thisis_test_section', 'ccleaner', $id);
            break;
            default:
                {//соответствия не нашлось выведем и имя и id
                    $a = new object;
                    $a->name = $name;
                    $a->id = $id;
                    return $this->dof->get_string('thisis_section_number', 'ccleaner', $a);
                }
		}
    }
     /** Возвращает текст для отображения в блоке dof
     * @return string  - html-код для отображения
     */
    public function get_blocknotes($format='other')
    {
		return "<a href='{$this->dof->url_im('ccleaner','/')}'>"
                    .$this->dof->get_string('title','ccleaner')."</a>";
    }
    /** Получить URL к собственным файлам плагина
     * @param string $adds[optional] - фрагмент пути внутри папки плагина
     *                                 начинается с /. Например '/index.php'
     * @param array $vars[optional] - параметры, передаваемые вместе с url
     * @return string - путь к папке с плагином 
     * @access public
     */
    public function url($adds='', $vars=array())
    {
        return $this->dof->url_im($this->code(), $adds, $vars);
    }
    /**
     * Возвращает объект приказа
     *
     * @param string $code
     * @param integer  $id
     * @return dof_storage_orders_baseorder
     */
    public function order($code,$id=NULL)
    {
        switch ($code)
        {
            case 'delete':
                // Хорошей мыслью будет сделать здесь кеширование
                $order = new dof_im_exampleim_order_delete($this->dof);
                if ( ! is_null($id) )
                {//не пустой приказ
                    if ( ! $order->load($id) )
                    {// приказ не найден
                        return false;
                    }
                }
                // Возвращаем объект
                return $order;
            break;
            default:
                // Ошибка
                return false;
        }
    }
    
    // **********************************************
    //              Собственные методы
    // **********************************************
    
    /** Получение таблицы с неактивными данными
     * @param string $type - тип данных
     * @return string - html-код таблицы
     */
    public function get_inactive_data_list($type='',$depid=0)
    {
        global $DB;
        switch($type)
        {
            case "persons":
                // получаем данные неактивных пользователей
                $conds = array();
                if ($depid) {
                    $conds = array('departmentid' => $depid);
                }
                return $this->dof->storage('persons')->get_records($conds);
                break;
            case "courses":
                // получаем данные неактивных курсов
                return $DB->get_records('course', array());
                break;
        }
        return array();
    }
    
    /** Получение таблицы с неактивными данными
     * @param string $type - тип данных
     * @return string/bool - html-код таблицы или fasle
     */
    public function get_inactive_data_table($type='',$depid=0)
    {
        // получаем данные для таблицы
        $data = array();
        $data = $this->get_inactive_data_list($type,$depid);
        
        $table = new stdClass();
        switch ($type)
        {
            case 'persons':
                
                $table->head = array('',
                        'person_lastname' => $this->dof->get_string('table_person_lastname', 'ccleaner'),
                        'person_firstname' => $this->dof->get_string('table_person_firstname', 'ccleaner'),
                        'person_middlename' => $this->dof->get_string('table_person_middlename', 'ccleaner'));
                
                $table->tablealign = 'center';
                $table->align = array('center','center','center','center');
                
                if ( !empty($data) )
                {
                    foreach ($data as $value)
                    {
                        $selection = "<input type='checkbox' name='inactive_flags[]' form='mform1' value='".$value->id."'/>";
                        $str = array('selection' => $selection,
                                'person_lastname' => $value->lastname,
                                'person_firstname' => $value->firstname,
                                'person_middlename' => $value->middlename);
                        
                        $table->data[] = $str;
                    }
                }else
                {
                    return false;
                }
                return $this->dof->modlib('widgets')->print_table($table,true);
                
            case 'courses':
                $table->head = array('',
                        'course_name' => $this->dof->get_string('table_course_name', 'ccleaner'),
                        'course_shortname' => $this->dof->get_string('table_course_shortname', 'ccleaner'),
                        'course_summary' => $this->dof->get_string('table_course_summary', 'ccleaner'));
                
                $table->tablealign = 'center';
                $table->align = array('center','center','center','center');
                if ( !empty($data) )
                {
                    foreach ($data as $value)
                    {
                        $selection = "<input type='checkbox' name='inactive_flags[]' form='mform1' value='".$value->id."'/>";
                        $str = array('selection' => $selection,
                                'course_name' => $value->fullname,
                                'course_shortname' => $value->shortname,
                                'course_summary' => $value->summary);
                        
                        $table->data[] = $str;
                    }
                }else
                {
                    return false;
                }
                return $this->dof->modlib('widgets')->print_table($table,true);
        }
        return false;
    }
}
